<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8"/>
        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
        <title>AJ Framework-统一返回结果</title>
        <meta name="description" content="AJ Framework 一个基于 SpringMVC 构建的轻量级框架，旨在增强 SpringMVC 并使其更具 SpringBoot 的特性。它拥有许多小型组件，非常易于使用。" />
        <meta name="keywords" content="AJ Framework, ajaxjs, ajaxjs framework, java framework, web framework" />
        <meta name="viewport" content="width=device-width, initial-scale=1"/>
        <link rel="preconnect" href="https://fonts.googleapis.com" />
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
        <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Noto+Serif+SC:wght@200..900&family=Noto+Serif:ital,wght@0,100..900;1,100..900&display=swap&family=Noto+Sans+SC:wght@100..900&display=swap" />
        <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Noto+Sans+SC:wght@100..900&family=Noto+Serif:ital,wght@0,100..900;1,100..900&display=swap" /> 
        <link rel="stylesheet" href="https://framework.ajaxjs.com/static/new-ui/css/common.css" />
        <link rel="stylesheet" href="https://iam.ajaxjs.com/asset/main.css"/>
        <link rel="icon" type="image/x-icon" href="https://framework.ajaxjs.com/aj-logo/logo.ico"/>
        <script src="https://framework.ajaxjs.com/static/aj-docs/common.js"></script>
        <script>
            var _hmt = _hmt || [];
            (function() {
              var hm = document.createElement("script");
              hm.src = "https://hm.baidu.com/hm.js?a3dec1d9b9415edd86b54c1fb3d02f19";
              var s = document.getElementsByTagName("script")[0];
              s.parentNode.insertBefore(hm, s);
            })();
        </script>
    </head>
    <body>
        <nav>
            <div>
                <div class="links">
                    <a href="/">🏠 首页</a>
                    | ⚙️ 源码:
                    <a target="_blank" href="https://github.com/lightweight-component/aj-framework">Github</a>/<a target="_blank" href="https://gitcode.com/lightweight-component/aj-framework">Gitcode</a>
                    |
                    <a href="/common/contact">✉️ 联系</a>
                </div>
                <h1>
                    <img src="https://framework.ajaxjs.com/aj-logo/logo.png" style="vertical-align: middle;height: 45px;margin-bottom: 6px;" />
                    AJ Framework
                </h1>
                <h3>轻量级 Java 快速开发框架
                </h3>
            </div>
        </nav>
        <div>
            <menu>
                
                <ul>
                    <li class="selected">
                        <a href="/">首页</a>
                    </li>
                </ul>
                <h3>框架基本用法</h3>
                <ul>
                    <li>
                        <a href="/framework/init">初始化一个项目</a>
                    </li>
                    <li>
                        <a href="/framework/controller">简化控制器为接口</a>
                    </li>
                    <li>
                        <a href="/framework/unified-return">统一对象返回</a>
                    </li>
                    <li>
                        <a href="/framework/unified-ex">统一异常处理</a>
                    </li>
                    <li>
                        <a href="/framework/package">打包与部署</a>
                    </li>
                </ul>
                <h3>常用组件</h3>
                <ul>
                    <li>
                        <a href="/component/db">数据库访问</a>
                    </li>
                    <li>
                        <a href="/component/bean-validator/">Bean 实体校验</a>
                    </li>
                    <li>
                        <a href="/component/security">安全组件、用户系统</a>
                    </li>
                    <li>
                        <a href="/component/lite-c/">使用简单本地缓存</a>
                    </li>
                  <li>
                       <a href="/component/cache/">使用多级缓存</a>
                   </li>
                </ul>

                <h3>其他</h3>
                <ul>
                    <li><a href="/common/contact">联系</a></li>
                </ul>
            </menu>
            <article class="aj-text chinese">
                <h1>统一返回结果</h1>
<p>开发 REST API 接口时往往需要和前端对接定义返回的数据结构，例如返回下面 JSON 格式的数据。</p>
<pre><code class="language-json">{
  &quot;success&quot;: true,
  &quot;code&quot;: null,
  &quot;msg&quot;: &quot;操作成功!&quot;,
  &quot;data&quot;: 具体的数据
}
</code></pre>
<p>Java 控制器中一般都一个统一返回对象，例如 Spring 自带的<code>ResponseEntity&lt;T&gt;</code>，其中泛型<code>T</code>是具体返回的数据类型。
但是每个控制器方法都返回这个实体，略显有点啰嗦，那么直接返回数据但又是统一结构的——那行不行？也就是写成这样：</p>
<pre><code class="language-java">@PostMapping(&quot;/submit&quot;)
boolean jsonSubmit(@RequestBody User user);

@GetMapping(&quot;/user&quot;)
User User();

@GetMapping(&quot;/user_desensitize&quot;)
User UserDesensitize();
</code></pre>
<p>其实可以的——这样代码显示更清爽，减少心智。我们整理一下有哪些情况：</p>
<ul>
<li>如果控制器方法返回的类型是<code>ResponseEntity&lt;T&gt;</code>，那么好，很简单，直接处理返回这个对象；</li>
<li>如果控制器方法没有返回 <code>ResponseEntity&lt;T&gt;</code>，则最终统一返回机制会自动加上。于是你的控制器返回的类型可以直接是 String/int/long/boolean/void/Object/Map/List/Array 等任意类型，当然也包括 Java Bean（POJO）（上述的例子）；</li>
<li>如果控制器方法返回的对象实现了接口<code>IUnifiedReturn</code>，那么表示这是一个自定义的返回对象，那么也简单，直接处理返回这个对象。这种适合比较特殊的返回结构，数量不是很多的</li>
<li>如果数量太多，希望是全局自定义返回对象的，我们也允许。同时可以达到类似第二点的效果，即忽略声明容器类，统一返回机制会自动加上。</li>
</ul>
<p>下面我们逐个实现。</p>
<h2>隐式返回</h2>
<p>框架的<code>ResponseResultWrapper</code>即是统一返回结果封装类。如下控制器写法自动返回。</p>
<pre><code class="language-java">@PostMapping(&quot;/submit&quot;)
boolean jsonSubmit(@RequestBody User user);

@GetMapping(&quot;/user&quot;)
User User();

@GetMapping(&quot;/user_desensitize&quot;)
User UserDesensitize();
</code></pre>
<p>框架提供两个特别的注解：</p>
<ul>
<li><code>@IgnoredGlobalReturn</code> 忽略全局返回，直接返回业务对象</li>
<li><code>@JsonMessage</code> 返回 JSON 结构时候，自定义 message 内容</li>
</ul>
<h2>自定义返回对象</h2>
<p>TODO</p>

            </article>
        </div>
        <footer>
             开源框架 <a href="https://framework.ajaxjs.com" target="_blank">AJ-Framework</a> 首页。联系方式：
             frank@ajaxjs.com，<a href="https://blog.csdn.net/zhangxin09" target="_blank">作者博客</a>
             <br />
             <br />
             Copyright © 2025 Frank Cheung. All rights reserved.
         </footer>
    </body>
</html>